📑 Reporter Refactor: Adds support for new teal_report and teal_card class
#884
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 3, 2025
|
Code Coverage SummaryDiff against mainResults for commit: 7c2dc13 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Unit Tests Summary 1 files 22 suites 2s ⏱️ Results for commit 7c2dc13. ♻️ This comment has been updated with latest results. |
Companion to insightsengineering/teal.reporter#334 Consequence of changing naming convention for `teal_report` object. --------- Co-authored-by: André Veríssimo <[email protected]>
averissimo
added a commit
to insightsengineering/teal.code
that referenced
this pull request
Jun 12, 2025
…l_data` (#255) # Pull Request Fixes: - insightsengineering/teal#1526 Built on top of: - insightsengineering/teal.reporter#307 - _(#307 will be closed once this PR is stable)_ ### Companion PRs: - insightsengineering/teal#1541 - #255 - insightsengineering/teal.data#370 - insightsengineering/teal.reporter#331 - insightsengineering/teal.modules.general#884 ### Changes description - [x] Add new parameter `cache` - Caches the result of the last evaluation in the respective `@code` slot - [ ] Decide on name - [x] Remove signature with multiple arguments to allow overriding `eval_code` in other packages without showing a note ``` r pkgload::load_all("teal.code") #> ℹ Loading teal.code q <- qenv() |> eval_code(1 + 1, cache = TRUE) |> eval_code(mtcars <- head(mtcars)) attr(q@code[[1]], "cache") #> [1] 2 ``` <sup>Created on 2025-06-03 with [reprex v2.1.1](https://reprex.tidyverse.org)</sup> --------- Co-authored-by: Dawid Kaledkowski <[email protected]> Co-authored-by: Marcin <[email protected]> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
averissimo
added a commit
to insightsengineering/teal.data
that referenced
this pull request
Jun 12, 2025
…l_data` (#370) # Pull Request Fixes: - insightsengineering/teal#1526 Built on top of: - insightsengineering/teal.reporter#307 - _(#307 will be closed once this PR is stable)_ ### Companion PRs: - insightsengineering/teal#1541 - insightsengineering/teal.code#255 - #370 - insightsengineering/teal.reporter#331 - insightsengineering/teal.modules.general#884 ### Changes description - [x] Cleanup of `teal_data` class to allow for `teal_report` extension - [x] Change the `show()` method to remove reference to `teal_data` specifically --------- Co-authored-by: Dawid Kaledkowski <[email protected]> Co-authored-by: Marcin <[email protected]>
m7pr
reviewed
Jun 13, 2025
# Pull Request
- Changes from `teal_reportable` branch at `{ŧeal.report}`
- Remove old logic that was defusing the argument
Signed-off-by: Marcin <[email protected]>
m7pr
reviewed
Jun 18, 2025
Merging this to a feature branch. The rest can be dona as normal issues. Thanks!
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
Signed-off-by: Marcin <[email protected]>
m7pr
reviewed
Aug 26, 2025
| plot_top <- plots[[1]] | ||
| plot_bottom <- plots[[2]] | ||
| plot <- gridExtra::grid.arrange(plot_top, plot_bottom, ncol = 1) | ||
| plot <- gridExtra::arrangeGrob(plots[[1]], plots[[2]], ncol = 1) |
There was a problem hiding this comment.
unused arguments (list(), "Race [RACE]")
when evaluating qenv code:
plot <- gridExtra::arrangeGrob(plots[[1]], plots[[2]], ncol = 1)
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 26, 2025
m7pr
reviewed
Aug 27, 2025
Comment on lines
+493
to
+508
| reactive({ | ||
| # Version 1 | ||
| # since data() is not being build up in this module, we need to create a reactive that will | ||
| # return the plot in the reactive teal_data() | ||
| validation_checks() | ||
| obj <- data() | ||
| env <- new.env() | ||
| assign("plot", variable_plot_r(), envir = env) | ||
| [email protected] <- rlang::env_clone(env) | ||
| teal.reporter::teal_card(obj) <- | ||
| c( | ||
| teal.reporter::teal_card("# Variable Browser Plot"), | ||
| teal.reporter::teal_card(obj), | ||
| teal.reporter::teal_card("## Module's code") | ||
| ) | ||
| teal.code::eval_code(obj, "plot") |
There was a problem hiding this comment.
Hey @averissimo this module is harder as it does not build up any code to show R code. originally it only showed the plot like in Version 2 below.
With version 1 we are able to show libraries call, and filtering code, but not the plot code and it looks odd. Also I needed to overwrite @.xData which is extremely dirty.
Do you think we rather support Version 1 or Version 2 for this module?
m7pr
reviewed
Aug 27, 2025
Comment on lines
+511
to
+513
| # VERSION 2 | ||
| # validation_checks() | ||
| # teal.data::teal_data(plot = variable_plot_r()) |> teal.code::eval_code("plot") |
m7pr
reviewed
Aug 27, 2025
|
|
||
| anl_merged_q <- reactive({ | ||
| req(anl_merged_input()) | ||
| qenv() %>% | ||
| teal.code::eval_code(as.expression(anl_merged_input()$expr)) %>% | ||
| teal.code::eval_code(quote(ANL)) # used to display table when running show-r-code code |
There was a problem hiding this comment.
m7pr
reviewed
Aug 27, 2025
| }) | ||
| ) | ||
|
|
||
| decorated_summary_table_q <- srv_decorate_teal_data( |
m7pr
reviewed
Aug 27, 2025
| card | ||
| reactive( | ||
| if (input$tabs == "Histogram") { | ||
| c(decorated_output_dist_q(), decorated_output_summary_q(), decorated_output_test_q()) |
There was a problem hiding this comment.
the c gives a warning - maybe we can add suppressWarning in here?
- do we need headers, for
Statistics tableandTests table?
Now it's just 2 tables under the plot
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Fixes:
Built on top of:
teal.reporterCards teal#1499 (will be closed once this PR is stable)Companion PRs:
teal_reportandteal_cardclass teal#1541{teal}module returns ateal_reportobject that extends fromteal_datateal.code#255{teal}module returns ateal_reportobject that extends fromteal_datateal.data#370teal_report,teal_cardclass and revamps reporter UI teal.reporter#331teal_reportandteal_cardclass #884Changes description
teal_reportobject on every module